EtherPeek 3.1 introduces the ability to periodically save statistics as HTML files, enabling you to view network information with a web browser. Use the new “HTML Output…” command in the statistics menu to access a dialog in which you can enable this feature and select a template folder and an output folder. EtherPeek will process all text files in the template folder you select and replace special keywords with packet statistics values and write the resulting files to the output folder. This method allows you to have almost complete control over the HTML that is produced. For example, you can customize the format and appearance of the tables that are produced, include your own text, graphics, and links, and you can keep separate files for each statistics table, or combine them into a single HTML document. Every piece of information in the source, destination, node activity, protocol and filter statistics windows can be accessed.
Important
• The corresponding statistics window must be open in order to output a statistics table as HTML. Why? Because otherwise EtherPeek doesn't spend the time to calculate the statistics in the first place.
• Output filenames are based on the template filename and are given the filename extension “.html”. Any existing filename extension on the template file is not used.
• Avoid choosing the same folder for templates and for output or templates may be overwritten (if they end in “.html” for example).
Template Keywords
The AG Group has provided a set of template files that you can use without modification, or as a starting point for customizing your own statistics tables.
Global Keywords
AG_UPDATE_INTERVAL
The refresh interval from the HTML Output Options dialog (in seconds).
AG_STATS_TIME
The date and time that the files last updated.
AG_SOURCE_STATS_TOTAL_PACKETS
The number of packets sent by nodes on the network.
AG_SOURCE_STATS_NODE_COUNT
The number of nodes that have sent packets on the network.
AG_SOURCE_STATS_TABLE_START
AG_SOURCE_STATS_TABLE_END
These keywords mark the start and end of template data that will be repeatedly written for each source node in that “Source Statistics” window. The template data should contain specific keywords that will be replaced for each item.
AG_DEST_STATS_TOTAL_PACKETS
The number of packets received by nodes on the network.
AG_DEST_STATS_NODE_COUNT
The number of nodes that have received packets on the network.
AG_DEST_STATS_TABLE_START
AG_DEST_STATS_TABLE_END
These keywords mark the start and end of template data that will be repeatedly written for each destination node in that “Destination Statistics” window. The template data should contain specific keywords that will be replaced for each item.
AG_DUAL_STATS_TOTAL_PACKETS
The total number of packets sent and received by nodes on the network.
AG_DUAL_STATS_NODE_COUNT
The total number of nodes that have sent or received packets on the network.
AG_DUAL_STATS_TABLE_START
AG_DUAL_STATS_TABLE_END
These keywords mark the start and end of template data that will be repeatedly written for each node in that “Node Activity Statistics” window. The template data should contain specific keywords that will be replaced for each item.
AG_PROTO_STATS_TOTAL_PACKETS
The number of packets observed on the network.
AG_PROTO_STATS_PROTOCOL_COUNT
The number of protocols that have been observed on the network.
AG_PROTO_STATS_TABLE_START
AG_PROTO_STATS_TABLE_END
These keywords mark the start and end of template data that will be repeatedly written for each protocol in that “Protocol Statistics” window. The template data should contain specific keywords that will be replaced for each item. Note that the format will match the hierarchy visible in the window to allow you to customize the output by opening or closing sub protocols.
AG_FILTER_STATS_TOTAL_PACKETS
The number of packets that have matched active filters.
AG_FILTER_STATS_FILTERS_MATCHED
The number of active filters that have matched captured packets.
AG_FILTER_STATS_TABLE_START
AG_FILTER_STATS_TABLE_END
These keywords mark the start and end of template data that will be repeatedly written for each node in that “Protocol Statistics” window. The template data should contain specific keywords that will be replaced for each item. Use the filter table output to generate highly customized tables of information by creating and activating your own filters.
Table Keywords
These keywords can appear within the template data marked with the “TABLE_START” and “TABLE_END” keywords from the list of global keywords described above (the table keywords are actually prefixed by the kind of statistics table). Any text that appears between the table start and end keywords will be repeatedly searched for the table-specific keywords and written for each item in the statistics list.
Source Statistics
AG_SOURCE_STATS_TABLE_COLOR
A 3-byte RGB color value (in hexadecimal, including the ‘#’ character).
AG_SOURCE_STATS_TABLE_NODE
The name or physical address of the node.
AG_SOURCE_STATS_TABLE_BARWIDTH
An integer value representing the length of the bar graph based on a 200 pixel maximum width. Note that this value does not consider the scaling factor used in the source statistics window.
AG_SOURCE_STATS_TABLE_PERCENT
A percentage value representing the proportion of packets sent by the specific node in relation to the total number of packets sent on the network.
AG_SOURCE_STATS_TABLE_PACKETS
The number of packets sent by the specific node.
Destination Statistics
AG_DEST_STATS_TABLE_COLOR
A 3-byte RGB color value (in hexadecimal, including the ‘#’ character).
AG_DEST_STATS_TABLE_NODE
The name or physical address of the node.
AG_DEST_STATS_TABLE_BARWIDTH
An integer value representing the length of the bar graph based on a 200 pixel maximum width. Note that this value does not consider the scaling factor used in the destination statistics window.
AG_DEST_STATS_TABLE_PERCENT
A percentage value representing the proportion of packets received by the specific node in relation to the total number of packets received on the network.
AG_DEST_STATS_TABLE_PACKETS
The number of packets received by the specific node.
Node Activity Statistics
AG_DUAL_STATS_TABLE_COLOR
A 3-byte RGB color value (in hexadecimal, including the ‘#’ character).
AG_DUAL_STATS_TABLE_NODE
The name or physical address of the node.
AG_DUAL_STATS_TABLE_SOURCE_BARWIDTH
An integer value representing the length of the bar graph based on a 200 pixel maximum width. This width is calculated using the number of packets sent by the specific node and the total number of packets sent on the network. Note that this value does not consider the scaling factor used in the node activity statistics window.
AG_DUAL_STATS_TABLE_SOURCE_PERCENT
A percentage value representing the proportion of packets sent by the specific node in relation to the total number of packets sent on the network.
AG_DUAL_STATS_TABLE_SOURCE_PACKETS
The number of packets sent by the specific node.
AG_DUAL_STATS_TABLE_DEST_BARWIDTH
An integer value representing the length of the bar graph based on a 200 pixel maximum width. This width is calculated using the number of packets received by the specific node and the total number of packets received on the network. Note that this value does not consider the scaling factor used in the node activity statistics window.
AG_DUAL_STATS_TABLE_DEST_PERCENT
A percentage value representing the proportion of packets received by the specific node in relation to the total number of packets received on the network.
AG_DUAL_STATS_TABLE_DEST_PACKETS
The number of packets received by the specific node.
Protocol Statistics
AG_PROTO_STATS_TABLE_COLOR
A 3-byte RGB color value (in hexadecimal, including the ‘#’ character).
AG_PROTO_STATS_TABLE_PROTOCOL
The name or hexadecimal representation of the protocol.
AG_PROTO_STATS_TABLE_BARWIDTH
An integer value representing the length of the bar graph based on a 200 pixel maximum width. Note that this value does not consider the scaling factor used in the protocol statistics window.
AG_PROTO_STATS_TABLE_PERCENT
A percentage value representing the proportion of packets of the specific protocol type in relation to the total number of packets observed on the network.
AG_PROTO_STATS_TABLE_PACKETS
The number of packets attributed to the specific protocol.
Filter Statistics
AG_FILTER_STATS_TABLE_COLOR
A 3-byte RGB color value (in hexadecimal, including the ‘#’ character).
AG_FILTER_STATS_TABLE_FILTER
The name of the specific filter.
AG_FILTER_STATS_TABLE_BARWIDTH
An integer value representing the length of the bar graph based on a 200 pixel maximum width. Note that this value does not consider the scaling factor used in the filter statistics window.
AG_FILTER_STATS_TABLE_PERCENT
A percentage value representing the proportion of packets matching the specific filter in relation to the total number of packets that have matched all active filters.
AG_FILTER_STATS_TABLE_PACKETS
The number of packets that have matched the specific filter.
